<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
<span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
<span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * (C) Copyright 2000-2014, by Object Refinery Limited and Contributors.<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * Project Info:  http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
<span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
<span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
<span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
<span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
<span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,<a name="line.21"></a>
<span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
<span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * ----------------------<a name="line.27"></a>
<span class="sourceLineNo">028</span> * RegularTimePeriod.java<a name="line.28"></a>
<span class="sourceLineNo">029</span> * ----------------------<a name="line.29"></a>
<span class="sourceLineNo">030</span> * (C) Copyright 2001-2014, by Object Refinery Limited.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Original Author:  David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Contributor(s):   -;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Changes<a name="line.35"></a>
<span class="sourceLineNo">036</span> * -------<a name="line.36"></a>
<span class="sourceLineNo">037</span> * 11-Oct-2001 : Version 1 (DG);<a name="line.37"></a>
<span class="sourceLineNo">038</span> * 26-Feb-2002 : Changed getStart(), getMiddle() and getEnd() methods to<a name="line.38"></a>
<span class="sourceLineNo">039</span> *               evaluate with reference to a particular time zone (DG);<a name="line.39"></a>
<span class="sourceLineNo">040</span> * 29-May-2002 : Implemented MonthConstants interface, so that these constants<a name="line.40"></a>
<span class="sourceLineNo">041</span> *               are conveniently available (DG);<a name="line.41"></a>
<span class="sourceLineNo">042</span> * 10-Sep-2002 : Added getSerialIndex() method (DG);<a name="line.42"></a>
<span class="sourceLineNo">043</span> * 10-Jan-2003 : Renamed TimePeriod --&gt; RegularTimePeriod (DG);<a name="line.43"></a>
<span class="sourceLineNo">044</span> * 13-Mar-2003 : Moved to com.jrefinery.data.time package (DG);<a name="line.44"></a>
<span class="sourceLineNo">045</span> * 29-Apr-2004 : Changed getMiddleMillisecond() methods to fix bug 943985 (DG);<a name="line.45"></a>
<span class="sourceLineNo">046</span> * 25-Nov-2004 : Added utility methods (DG);<a name="line.46"></a>
<span class="sourceLineNo">047</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.47"></a>
<span class="sourceLineNo">048</span> * 06-Oct-2006 : Deprecated the WORKING_CALENDAR field and several methods,<a name="line.48"></a>
<span class="sourceLineNo">049</span> *               added new peg() method (DG);<a name="line.49"></a>
<span class="sourceLineNo">050</span> * 16-Sep-2008 : Deprecated DEFAULT_TIME_ZONE (DG);<a name="line.50"></a>
<span class="sourceLineNo">051</span> * 23-Feb-2014 : Added getMillisecond() method (DG);<a name="line.51"></a>
<span class="sourceLineNo">052</span> * <a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>package org.jfree.data.time;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>import java.lang.reflect.Constructor;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import java.util.Calendar;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import java.util.Date;<a name="line.59"></a>
<span class="sourceLineNo">060</span>import java.util.TimeZone;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>import org.jfree.date.MonthConstants;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>/**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * An abstract class representing a unit of time.  Convenient methods are<a name="line.65"></a>
<span class="sourceLineNo">066</span> * provided for calculating the next and previous time periods.  Conversion<a name="line.66"></a>
<span class="sourceLineNo">067</span> * methods are defined that return the first and last milliseconds of the time<a name="line.67"></a>
<span class="sourceLineNo">068</span> * period.  The results from these methods are timezone dependent.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;P&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * This class is immutable, and all subclasses should be immutable also.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span>public abstract class RegularTimePeriod implements TimePeriod, Comparable,<a name="line.72"></a>
<span class="sourceLineNo">073</span>        MonthConstants {<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Creates a time period that includes the specified millisecond, assuming<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * the given time zone.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     *<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param c  the time period class.<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param millisecond  the time.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param zone  the time zone.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     *<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @return The time period.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public static RegularTimePeriod createInstance(Class c, Date millisecond,<a name="line.85"></a>
<span class="sourceLineNo">086</span>            TimeZone zone) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        RegularTimePeriod result = null;<a name="line.87"></a>
<span class="sourceLineNo">088</span>        try {<a name="line.88"></a>
<span class="sourceLineNo">089</span>            Constructor constructor = c.getDeclaredConstructor(<a name="line.89"></a>
<span class="sourceLineNo">090</span>                    new Class[] {Date.class, TimeZone.class});<a name="line.90"></a>
<span class="sourceLineNo">091</span>            result = (RegularTimePeriod) constructor.newInstance(<a name="line.91"></a>
<span class="sourceLineNo">092</span>                    new Object[] {millisecond, zone});<a name="line.92"></a>
<span class="sourceLineNo">093</span>        }<a name="line.93"></a>
<span class="sourceLineNo">094</span>        catch (Exception e) {<a name="line.94"></a>
<span class="sourceLineNo">095</span>            // do nothing, so null is returned<a name="line.95"></a>
<span class="sourceLineNo">096</span>        }<a name="line.96"></a>
<span class="sourceLineNo">097</span>        return result;<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * Returns a subclass of {@link RegularTimePeriod} that is smaller than<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * the specified class.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * @param c  a subclass of {@link RegularTimePeriod}.<a name="line.104"></a>
<span class="sourceLineNo">105</span>     *<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * @return A class.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     */<a name="line.107"></a>
<span class="sourceLineNo">108</span>    public static Class downsize(Class c) {<a name="line.108"></a>
<span class="sourceLineNo">109</span>        if (c.equals(Year.class)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>            return Quarter.class;<a name="line.110"></a>
<span class="sourceLineNo">111</span>        }<a name="line.111"></a>
<span class="sourceLineNo">112</span>        else if (c.equals(Quarter.class)) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>            return Month.class;<a name="line.113"></a>
<span class="sourceLineNo">114</span>        }<a name="line.114"></a>
<span class="sourceLineNo">115</span>        else if (c.equals(Month.class)) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>            return Day.class;<a name="line.116"></a>
<span class="sourceLineNo">117</span>        }<a name="line.117"></a>
<span class="sourceLineNo">118</span>        else if (c.equals(Day.class)) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>            return Hour.class;<a name="line.119"></a>
<span class="sourceLineNo">120</span>        }<a name="line.120"></a>
<span class="sourceLineNo">121</span>        else if (c.equals(Hour.class)) {<a name="line.121"></a>
<span class="sourceLineNo">122</span>            return Minute.class;<a name="line.122"></a>
<span class="sourceLineNo">123</span>        }<a name="line.123"></a>
<span class="sourceLineNo">124</span>        else if (c.equals(Minute.class)) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>            return Second.class;<a name="line.125"></a>
<span class="sourceLineNo">126</span>        }<a name="line.126"></a>
<span class="sourceLineNo">127</span>        else if (c.equals(Second.class)) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>            return Millisecond.class;<a name="line.128"></a>
<span class="sourceLineNo">129</span>        }<a name="line.129"></a>
<span class="sourceLineNo">130</span>        else {<a name="line.130"></a>
<span class="sourceLineNo">131</span>            return Millisecond.class;<a name="line.131"></a>
<span class="sourceLineNo">132</span>        }<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * Returns the time period preceding this one, or &lt;code&gt;null&lt;/code&gt; if some<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * lower limit has been reached.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * @return The previous time period (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.139"></a>
<span class="sourceLineNo">140</span>     */<a name="line.140"></a>
<span class="sourceLineNo">141</span>    public abstract RegularTimePeriod previous();<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>    /**<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * Returns the time period following this one, or &lt;code&gt;null&lt;/code&gt; if some<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * limit has been reached.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     *<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * @return The next time period (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.147"></a>
<span class="sourceLineNo">148</span>     */<a name="line.148"></a>
<span class="sourceLineNo">149</span>    public abstract RegularTimePeriod next();<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Returns a serial index number for the time unit.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return The serial index number.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    public abstract long getSerialIndex();<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span>    //////////////////////////////////////////////////////////////////////////<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span>    /**<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * The default time zone.<a name="line.161"></a>
<span class="sourceLineNo">162</span>     *<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * @deprecated As of 1.0.11, we discourage the use of this field - use<a name="line.163"></a>
<span class="sourceLineNo">164</span>     *     {@link TimeZone#getDefault()} instead.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     */<a name="line.165"></a>
<span class="sourceLineNo">166</span>    public static final TimeZone DEFAULT_TIME_ZONE = TimeZone.getDefault();<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>    /**<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * A working calendar (recycle to avoid unnecessary object creation).<a name="line.169"></a>
<span class="sourceLineNo">170</span>     *<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @deprecated This was a bad idea, don't use it!<a name="line.171"></a>
<span class="sourceLineNo">172</span>     */<a name="line.172"></a>
<span class="sourceLineNo">173</span>    public static final Calendar WORKING_CALENDAR = Calendar.getInstance(<a name="line.173"></a>
<span class="sourceLineNo">174</span>            DEFAULT_TIME_ZONE);<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span>    /**<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * Recalculates the start date/time and end date/time for this time period<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * relative to the supplied calendar (which incorporates a time zone).<a name="line.178"></a>
<span class="sourceLineNo">179</span>     *<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @param calendar  the calendar (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.180"></a>
<span class="sourceLineNo">181</span>     *<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @since 1.0.3<a name="line.182"></a>
<span class="sourceLineNo">183</span>     */<a name="line.183"></a>
<span class="sourceLineNo">184</span>    public abstract void peg(Calendar calendar);<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span>    /**<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * Returns the date/time that marks the start of the time period.  This<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * method returns a new &lt;code&gt;Date&lt;/code&gt; instance every time it is called.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @return The start date/time.<a name="line.190"></a>
<span class="sourceLineNo">191</span>     *<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * @see #getFirstMillisecond()<a name="line.192"></a>
<span class="sourceLineNo">193</span>     */<a name="line.193"></a>
<span class="sourceLineNo">194</span>    @Override<a name="line.194"></a>
<span class="sourceLineNo">195</span>    public Date getStart() {<a name="line.195"></a>
<span class="sourceLineNo">196</span>        return new Date(getFirstMillisecond());<a name="line.196"></a>
<span class="sourceLineNo">197</span>    }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span>    /**<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * Returns the date/time that marks the end of the time period.  This<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * method returns a new &lt;code&gt;Date&lt;/code&gt; instance every time it is called.<a name="line.201"></a>
<span class="sourceLineNo">202</span>     *<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * @return The end date/time.<a name="line.203"></a>
<span class="sourceLineNo">204</span>     *<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * @see #getLastMillisecond()<a name="line.205"></a>
<span class="sourceLineNo">206</span>     */<a name="line.206"></a>
<span class="sourceLineNo">207</span>    @Override<a name="line.207"></a>
<span class="sourceLineNo">208</span>    public Date getEnd() {<a name="line.208"></a>
<span class="sourceLineNo">209</span>        return new Date(getLastMillisecond());<a name="line.209"></a>
<span class="sourceLineNo">210</span>    }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span>    /**<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * Returns the first millisecond of the time period.  This will be<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * determined relative to the time zone specified in the constructor, or<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * in the calendar instance passed in the most recent call to the<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * {@link #peg(Calendar)} method.<a name="line.216"></a>
<span class="sourceLineNo">217</span>     *<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * @return The first millisecond of the time period.<a name="line.218"></a>
<span class="sourceLineNo">219</span>     *<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * @see #getLastMillisecond()<a name="line.220"></a>
<span class="sourceLineNo">221</span>     */<a name="line.221"></a>
<span class="sourceLineNo">222</span>    public abstract long getFirstMillisecond();<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span>    /**<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * Returns the first millisecond of the time period, evaluated within a<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * specific time zone.<a name="line.226"></a>
<span class="sourceLineNo">227</span>     *<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * @param zone  the time zone (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.228"></a>
<span class="sourceLineNo">229</span>     *<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * @return The first millisecond of the time period.<a name="line.230"></a>
<span class="sourceLineNo">231</span>     *<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @deprecated As of 1.0.3, you should avoid using this method (it creates<a name="line.232"></a>
<span class="sourceLineNo">233</span>     *     a new Calendar instance every time it is called).  You are advised<a name="line.233"></a>
<span class="sourceLineNo">234</span>     *     to call {@link #getFirstMillisecond(Calendar)} instead.<a name="line.234"></a>
<span class="sourceLineNo">235</span>     *<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * @see #getLastMillisecond(TimeZone)<a name="line.236"></a>
<span class="sourceLineNo">237</span>     */<a name="line.237"></a>
<span class="sourceLineNo">238</span>    public long getFirstMillisecond(TimeZone zone) {<a name="line.238"></a>
<span class="sourceLineNo">239</span>        Calendar calendar = Calendar.getInstance(zone);<a name="line.239"></a>
<span class="sourceLineNo">240</span>        return getFirstMillisecond(calendar);<a name="line.240"></a>
<span class="sourceLineNo">241</span>    }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span>    /**<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * Returns the first millisecond of the time period, evaluated using the<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * supplied calendar (which incorporates a timezone).<a name="line.245"></a>
<span class="sourceLineNo">246</span>     *<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * @param calendar  the calendar (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.247"></a>
<span class="sourceLineNo">248</span>     *<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * @return The first millisecond of the time period.<a name="line.249"></a>
<span class="sourceLineNo">250</span>     *<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * @throws NullPointerException if {@code calendar} is {@code null}.<a name="line.251"></a>
<span class="sourceLineNo">252</span>     *<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * @see #getLastMillisecond(Calendar)<a name="line.253"></a>
<span class="sourceLineNo">254</span>     */<a name="line.254"></a>
<span class="sourceLineNo">255</span>    public abstract long getFirstMillisecond(Calendar calendar);<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span>    /**<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * Returns the last millisecond of the time period.  This will be<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * determined relative to the time zone specified in the constructor, or<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * in the calendar instance passed in the most recent call to the<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * {@link #peg(Calendar)} method.<a name="line.261"></a>
<span class="sourceLineNo">262</span>     *<a name="line.262"></a>
<span class="sourceLineNo">263</span>     * @return The last millisecond of the time period.<a name="line.263"></a>
<span class="sourceLineNo">264</span>     *<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * @see #getFirstMillisecond()<a name="line.265"></a>
<span class="sourceLineNo">266</span>     */<a name="line.266"></a>
<span class="sourceLineNo">267</span>    public abstract long getLastMillisecond();<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span>    /**<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * Returns the last millisecond of the time period, evaluated within a<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * specific time zone.<a name="line.271"></a>
<span class="sourceLineNo">272</span>     *<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * @param zone  the time zone (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.273"></a>
<span class="sourceLineNo">274</span>     *<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * @return The last millisecond of the time period.<a name="line.275"></a>
<span class="sourceLineNo">276</span>     *<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * @deprecated As of 1.0.3, you should avoid using this method (it creates<a name="line.277"></a>
<span class="sourceLineNo">278</span>     *     a new Calendar instance every time it is called).  You are advised<a name="line.278"></a>
<span class="sourceLineNo">279</span>     *     to call {@link #getLastMillisecond(Calendar)} instead.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     *<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * @see #getFirstMillisecond(TimeZone)<a name="line.281"></a>
<span class="sourceLineNo">282</span>     */<a name="line.282"></a>
<span class="sourceLineNo">283</span>    public long getLastMillisecond(TimeZone zone) {<a name="line.283"></a>
<span class="sourceLineNo">284</span>        Calendar calendar = Calendar.getInstance(zone);<a name="line.284"></a>
<span class="sourceLineNo">285</span>        return getLastMillisecond(calendar);<a name="line.285"></a>
<span class="sourceLineNo">286</span>    }<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span>    /**<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * Returns the last millisecond of the time period, evaluated using the<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * supplied calendar (which incorporates a timezone).<a name="line.290"></a>
<span class="sourceLineNo">291</span>     *<a name="line.291"></a>
<span class="sourceLineNo">292</span>     * @param calendar  the calendar (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.292"></a>
<span class="sourceLineNo">293</span>     *<a name="line.293"></a>
<span class="sourceLineNo">294</span>     * @return The last millisecond of the time period.<a name="line.294"></a>
<span class="sourceLineNo">295</span>     *<a name="line.295"></a>
<span class="sourceLineNo">296</span>     * @see #getFirstMillisecond(Calendar)<a name="line.296"></a>
<span class="sourceLineNo">297</span>     */<a name="line.297"></a>
<span class="sourceLineNo">298</span>    public abstract long getLastMillisecond(Calendar calendar);<a name="line.298"></a>
<span class="sourceLineNo">299</span><a name="line.299"></a>
<span class="sourceLineNo">300</span>    /**<a name="line.300"></a>
<span class="sourceLineNo">301</span>     * Returns the millisecond closest to the middle of the time period.<a name="line.301"></a>
<span class="sourceLineNo">302</span>     *<a name="line.302"></a>
<span class="sourceLineNo">303</span>     * @return The middle millisecond.<a name="line.303"></a>
<span class="sourceLineNo">304</span>     */<a name="line.304"></a>
<span class="sourceLineNo">305</span>    public long getMiddleMillisecond() {<a name="line.305"></a>
<span class="sourceLineNo">306</span>        long m1 = getFirstMillisecond();<a name="line.306"></a>
<span class="sourceLineNo">307</span>        long m2 = getLastMillisecond();<a name="line.307"></a>
<span class="sourceLineNo">308</span>        return m1 + (m2 - m1) / 2;<a name="line.308"></a>
<span class="sourceLineNo">309</span>    }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span>    /**<a name="line.311"></a>
<span class="sourceLineNo">312</span>     * Returns the millisecond closest to the middle of the time period,<a name="line.312"></a>
<span class="sourceLineNo">313</span>     * evaluated within a specific time zone.<a name="line.313"></a>
<span class="sourceLineNo">314</span>     *<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * @param zone  the time zone (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.315"></a>
<span class="sourceLineNo">316</span>     *<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * @return The middle millisecond.<a name="line.317"></a>
<span class="sourceLineNo">318</span>     *<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * @deprecated As of 1.0.3, you should avoid using this method (it creates<a name="line.319"></a>
<span class="sourceLineNo">320</span>     *     a new Calendar instance every time it is called).  You are advised<a name="line.320"></a>
<span class="sourceLineNo">321</span>     *     to call {@link #getMiddleMillisecond(Calendar)} instead.<a name="line.321"></a>
<span class="sourceLineNo">322</span>     */<a name="line.322"></a>
<span class="sourceLineNo">323</span>    public long getMiddleMillisecond(TimeZone zone) {<a name="line.323"></a>
<span class="sourceLineNo">324</span>        Calendar calendar = Calendar.getInstance(zone);<a name="line.324"></a>
<span class="sourceLineNo">325</span>        long m1 = getFirstMillisecond(calendar);<a name="line.325"></a>
<span class="sourceLineNo">326</span>        long m2 = getLastMillisecond(calendar);<a name="line.326"></a>
<span class="sourceLineNo">327</span>        return m1 + (m2 - m1) / 2;<a name="line.327"></a>
<span class="sourceLineNo">328</span>    }<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span>    /**<a name="line.330"></a>
<span class="sourceLineNo">331</span>     * Returns the millisecond closest to the middle of the time period,<a name="line.331"></a>
<span class="sourceLineNo">332</span>     * evaluated using the supplied calendar (which incorporates a timezone).<a name="line.332"></a>
<span class="sourceLineNo">333</span>     *<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * @param calendar  the calendar.<a name="line.334"></a>
<span class="sourceLineNo">335</span>     *<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * @return The middle millisecond.<a name="line.336"></a>
<span class="sourceLineNo">337</span>     */<a name="line.337"></a>
<span class="sourceLineNo">338</span>    public long getMiddleMillisecond(Calendar calendar) {<a name="line.338"></a>
<span class="sourceLineNo">339</span>        long m1 = getFirstMillisecond(calendar);<a name="line.339"></a>
<span class="sourceLineNo">340</span>        long m2 = getLastMillisecond(calendar);<a name="line.340"></a>
<span class="sourceLineNo">341</span>        return m1 + (m2 - m1) / 2;<a name="line.341"></a>
<span class="sourceLineNo">342</span>    }<a name="line.342"></a>
<span class="sourceLineNo">343</span><a name="line.343"></a>
<span class="sourceLineNo">344</span>    /**<a name="line.344"></a>
<span class="sourceLineNo">345</span>     * Returns the millisecond (relative to the epoch) corresponding to the <a name="line.345"></a>
<span class="sourceLineNo">346</span>     * specified &lt;code&gt;anchor&lt;/code&gt; using the supplied &lt;code&gt;calendar&lt;/code&gt; <a name="line.346"></a>
<span class="sourceLineNo">347</span>     * (which incorporates a time zone).<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * <a name="line.348"></a>
<span class="sourceLineNo">349</span>     * @param anchor  the anchor (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * @param calendar  the calendar (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * <a name="line.351"></a>
<span class="sourceLineNo">352</span>     * @return Milliseconds since the epoch.<a name="line.352"></a>
<span class="sourceLineNo">353</span>     * <a name="line.353"></a>
<span class="sourceLineNo">354</span>     * @since 1.0.18<a name="line.354"></a>
<span class="sourceLineNo">355</span>     */<a name="line.355"></a>
<span class="sourceLineNo">356</span>    public long getMillisecond(TimePeriodAnchor anchor, Calendar calendar) {<a name="line.356"></a>
<span class="sourceLineNo">357</span>        if (anchor.equals(TimePeriodAnchor.START)) {<a name="line.357"></a>
<span class="sourceLineNo">358</span>            return getFirstMillisecond(calendar);<a name="line.358"></a>
<span class="sourceLineNo">359</span>        } else if (anchor.equals(TimePeriodAnchor.MIDDLE)) {<a name="line.359"></a>
<span class="sourceLineNo">360</span>            return getMiddleMillisecond(calendar);<a name="line.360"></a>
<span class="sourceLineNo">361</span>        } else if (anchor.equals(TimePeriodAnchor.END)) {<a name="line.361"></a>
<span class="sourceLineNo">362</span>            return getLastMillisecond(calendar);<a name="line.362"></a>
<span class="sourceLineNo">363</span>        } else {<a name="line.363"></a>
<span class="sourceLineNo">364</span>            throw new IllegalStateException("Unrecognised anchor: " + anchor);<a name="line.364"></a>
<span class="sourceLineNo">365</span>        }<a name="line.365"></a>
<span class="sourceLineNo">366</span>    }<a name="line.366"></a>
<span class="sourceLineNo">367</span>    <a name="line.367"></a>
<span class="sourceLineNo">368</span>    /**<a name="line.368"></a>
<span class="sourceLineNo">369</span>     * Returns a string representation of the time period.<a name="line.369"></a>
<span class="sourceLineNo">370</span>     *<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * @return The string.<a name="line.371"></a>
<span class="sourceLineNo">372</span>     */<a name="line.372"></a>
<span class="sourceLineNo">373</span>    @Override<a name="line.373"></a>
<span class="sourceLineNo">374</span>    public String toString() {<a name="line.374"></a>
<span class="sourceLineNo">375</span>        return String.valueOf(getStart());<a name="line.375"></a>
<span class="sourceLineNo">376</span>    }<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span>}<a name="line.378"></a>




























































</pre>
</div>
</body>
</html>
